home *** CD-ROM | disk | FTP | other *** search
/ Merciful 5 / Merciful - Disc 5.iso / software / p / pcqpascalv1.2d.lha / Examples2 / cal / cal.doc < prev    next >
Text File  |  1997-05-06  |  4KB  |  190 lines
  1.  
  2.          cal, Version 2.0
  3.          Copyright © 1995 by Andreas Tetzl
  4.          This is FREEWARE !
  5.  
  6.  
  7.  
  8. INTRODUCTION
  9.  
  10.     Cal is a shell command similar to the one found on UNIX systems.
  11.     It shows a calendar of the current month or any other month.
  12.  
  13.  
  14.  
  15. DISTRIBUTION
  16.  
  17.     Cal is FREEWARE ! It is freely distributable
  18.     as long as no files of the archive are changed or
  19.     removed. Commercial use is prohibited without
  20.     permission of the author.
  21.  
  22.  
  23.  
  24. REQUIREMENTS
  25.  
  26.     Cal needs at least Kickstart 2.0 v37.
  27.     If you have Kickstart v38+ installed, it will use the
  28.     locale.library.
  29.  
  30.  
  31.  
  32. NEW FOR 2.0
  33.  
  34.     - calendars from year 1 to 3000
  35.     - highlighting of special days
  36.  
  37.  
  38.  
  39. INSTALLATION
  40.  
  41.     Copy cal to c: or somewhere in your path.
  42.     Copy the file cal.dates to s: .
  43.  
  44.  
  45.  
  46. CLI OPTIONS
  47.  
  48.     options:
  49.      MONTH : the month (1..12)
  50.      YEAR  : the year  (1..3000)
  51.               IMPORTANT: short form (95) is NOT allowed !
  52.      Y     : turn the year-calendar on (useful for year 1..12)
  53.      DATES : filename of config (see section configuration)
  54.  
  55.  
  56.     If you give no arguments, the current month is shown.
  57.     Use MONTH and/or YEAR to show other month.
  58.  
  59.     If you specify only a year or use the switch Y, a complete
  60.     calendar of this year is shown.
  61.  
  62.  
  63.  
  64.     examples:
  65.      cal 4            ; april of current year
  66.      cal 2 1993       ; feb-1993
  67.      cal 12 2000      ; dec-2000
  68.      cal 1523         ; calendar of 1523
  69.      cal 10 y         ; calendar of year (!) 10
  70.  
  71.  
  72.  
  73. CALENDAR FORMAT
  74.  
  75.     Per default sunday is shown at first position.
  76.  
  77.     To switch the calendar format (Sunday first or last) you
  78.     have to set the environment variable SUNDAY_LAST.
  79.  
  80.     Use 'setenv SUNDAY_LAST 1', if you want sunday at last
  81.     position, SUNDAY_LAST = 0 otherwise.
  82.  
  83.     If you want SUNDAY_LAST set up permanently you have to copy
  84.     the variable to ENVARC.
  85.  
  86.     use:
  87.     copy ENV:SUNDAY_LAST ENVARC:
  88.  
  89.  
  90.     If you have locale.libray installed, the format of the
  91.     calendar is taken from the locale country settings.
  92.  
  93.     Setting the env variable will override locale settings.
  94.  
  95.  
  96.  
  97. CONFIGURATION
  98.  
  99.     This section explains the file cal.dates.
  100.  
  101.  
  102.     This file contains the information about highlighting of
  103.     special dates. It can be located in s:, the current directory,
  104.     where you start cal from, or you can specify the filename
  105.     by using the cli-argument DATES (see section CLI OPTIONS).
  106.  
  107.     If this file does not exists, there won't be any error message.
  108.     If it contains a syntax error or an invalid date, an error
  109.     message is shown before the calendar.
  110.  
  111.     Each line consists of the date itself and one or more
  112.     attributes. A comment is indicated by a semicolon ';'.
  113.  
  114.     format
  115.       year-month-day    attributes
  116.  
  117.     For year and month you can also use '?', if you want every
  118.     year/month.
  119.  
  120.     known attributes
  121.       B     - bold
  122.       I     - italics
  123.       U     - underlined
  124.       C0..9 - color 0 to 9
  125.       R0..9 - background color 0 to 9
  126.  
  127.       note: You can only use color values higher than 3, if you
  128.             have enough colors on your workbench screen.
  129.  
  130.     example:
  131.  
  132.     1995-11-3    B C2
  133.  
  134.     If you execute "cal 11 1995", november 1995 is shown and
  135.     the 3rd will be bold and white.
  136.  
  137.     See cal.dates for more examples.
  138.  
  139.  
  140.  
  141. THANKS
  142.  
  143.     Mattias Ahnberg, email: overlord@kuai.se
  144.        for beta testing
  145.  
  146.     Jens Borsdorf
  147.        for beta testing
  148.  
  149.     Kay Drangmeister
  150.        for a locale.library hint
  151.  
  152.     Kai Hofmann
  153.        for some infos about the gregorian reformation
  154.  
  155.  
  156.  
  157. THE AUTHOR
  158.  
  159.     snailmail:
  160.  
  161.      Andreas Tetzl
  162.      Liebethaler Str. 18
  163.      01796 Pirna
  164.      Germany
  165.  
  166.  
  167.     email:
  168.  
  169.      atetzl@hawk.sax.de
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.